/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.ee.cms.impl.common;

import java.util.ArrayList;
import java.util.List;
import java.util.Vector;

/**
 * Provides support for maintaining information about an impending shutdown
 * announcement either in an instance context or in a group context. An instance
 * of this object is consulted for distinguishing an abnormal failure from a
 * planned shutdown resulting in a failure notification from heart beat agents.
 * Also consulted for determining if a member being suspected has already
 * announced shutdown or there is a group shutdown.
 *
 * @author Shreedhar Ganapathy
 *         Date: Sep 21, 2005
 * @version $Revision: 1.3 $
 */
public class ShutdownHelper {
    private final List<String> gracefulShutdownList = new Vector<String>();
    private final List<String> groupShutdownList = new ArrayList<String>();

    public ShutdownHelper() {

    }

    public synchronized boolean isGroupBeingShutdown(final String groupName) {
        return groupShutdownList.contains(groupName);
    }

    public synchronized boolean isMemberBeingShutdown(final String memberToken) {
        return gracefulShutdownList.contains(memberToken);
    }

    public void addToGroupShutdownList(final String groupName) {
        synchronized (groupShutdownList) {
            groupShutdownList.add(groupName);
        }
    }

    public void addToGracefulShutdownList(final String memberToken) {
        synchronized (gracefulShutdownList) {
            gracefulShutdownList.add(memberToken);
        }
    }

    public void removeFromGracefulShutdownList(final String memberToken) {
        synchronized (gracefulShutdownList) {
            gracefulShutdownList.remove(memberToken);
        }
    }

    public void removeFromGroupShutdownList(final String groupName) {
        synchronized (groupShutdownList) {
            groupShutdownList.remove(groupName);
        }
    }
}
